home *** CD-ROM | disk | FTP | other *** search
/ Komputer for Alle 2003 Ekstra 100 Spil / K-CD_2003_Ekstra_100_Spil.iso / Board / 4free / 4free.exe / {app} / open4.txt < prev    next >
Text File  |  2002-01-29  |  9KB  |  174 lines
  1. General Notes
  2. =============
  3.  
  4. This game supports Open Line up 4. Basically, if you know how to 
  5. create a windows dll you can replace our computer player with your 
  6. own.
  7.  
  8. If you create a new 'Engine.dll' feel free to send it to us and, 
  9. if you agree, we may host it on our site for others to try.
  10.  
  11. Note that you may not redistribute this game for commercial purposes.
  12. You may also not change the images or credits currently in the game.
  13. If you wish to use a modified version of this game without our 
  14. credits images, or advertising dialog feel free to contact us.
  15.  
  16. If you program in C++, an empty ms developer studio project is included 
  17. with this install for convenience. The file is called emptyplayer.zip
  18. and is in the root directory.
  19.  
  20. Technical Details
  21. =================
  22.  
  23. Engine.dll must be located in a subdirectory under "[4Free root]\Engines" and have the following interface:
  24.  
  25. VOID WINAPI C4_Desc       (char* pc, size_t size);
  26. BOOL WINAPI C4_NewGame    (long width, long height, long num);
  27. BOOL WINAPI C4_PlayMove   (long player, long column);
  28. LONG WINAPI C4_AutoMove   (long player, long level);
  29. LONG WINAPI C4_GetState   (long x, long y);
  30. BOOL WINAPI C4_IsWinner   (long player);
  31. BOOL WINAPI C4_IsTie      (void);
  32. VOID WINAPI C4_WinCoords  (long player, long* x1, long* y1, long* x2, long* y2);
  33. VOID WINAPI C4_EndGame    (void);
  34. BOOL WINAPI C4_EnumLevels (long level, char* pc, size_t size);
  35.  
  36.  
  37. The exported function names should be as exactly they are written here (C/C++ programmers should use a .DEF file to specify an undecorated function name).
  38.  
  39. The functions are described as follows:
  40.  
  41. 1. VOID WINAPI C4_Desc (char* pc, size_t size)
  42.  
  43. /****************************************************************************/
  44. /**                                                                        **/
  45. /**  This function returns a brief description for the Engine that is to   **/
  46. /**  be displayed in the 'options' dialog.                                 **/
  47. /**                                                                        **/
  48. /****************************************************************************/
  49.  
  50.  
  51. 2. BOOL WINAPI C4_NewGame (long width, long height, long unused)
  52.  
  53. /****************************************************************************/
  54. /**                                                                        **/
  55. /**  This function sets up a new game.  This must be called exactly once   **/
  56. /**  before each game is started.  Before it can be called a second time,  **/
  57. /**  C4_EndGame() must be called to destroy the previous game.             **/
  58. /**                                                                        **/
  59. /**  width and height are the desired dimensions of the game board.        **/
  60. /**                                                                        **/
  61. /**  This function returns TRUE if the game was successfully started,      **/
  62. /**  FALSE otherwise.                                                      **/
  63. /**                                                                        **/
  64. /****************************************************************************/
  65.  
  66.  
  67. 3. BOOL WINAPI C4_PlayMove (long player, long column)
  68.  
  69. /****************************************************************************/
  70. /**                                                                        **/
  71. /**  This function drops a piece of the specified player into the          **/
  72. /**  specified column.  Note that column numbering starts at 0.  A value   **/
  73. /**  of TRUE is returned if the drop was successful, or FALSE otherwise.   **/
  74. /**  A drop is unsuccessful if the specified column number is invalid or   **/
  75. /**  full.                                                                 **/
  76. /**                                                                        **/
  77. /****************************************************************************/
  78.  
  79.  
  80. 4. LONG WINAPI C4_AutoMove (long player, long level)
  81.  
  82.  
  83. /****************************************************************************/
  84. /**                                                                        **/
  85. /**  This function instructs the computer to make a move for the specified **/
  86. /**  player.  level specifies the 'level' option specified by the user in  **/
  87. /**  the options dialog.  The column number of the column in which         **/
  88. /**  the piece was dropped is returned.  Note that column numbering starts **/
  89. /**  at 0.  If no move is possible (i.e. the game board is full), -1 is    **/
  90. /**  returned.                                                             **/
  91. /**                                                                        **/
  92. /****************************************************************************/
  93.  
  94.  
  95. 5. LONG WINAPI C4_GetState (long x, long y)
  96.  
  97.  
  98. /****************************************************************************/
  99. /** The board configuration of the game state.                             **/
  100. /** C4_GetState(x,y) specifies the state of the                            **/
  101. /** xth column and the yth row of the board,                               **/
  102. /** where column and row numbering starts at 0.                            **/
  103. /** (The 0th row is the bottom row.)                                       **/
  104. /** A value of C4_PLAYER0 specifies that the position is                   **/
  105. /** occupied by a piece owned by player 0, a                               **/
  106. /** value of C4_PLAYER1 specifies that the position is                     **/
  107. /** occupied by a piece owned by player 1, and                             **/
  108. /** a value of C4_NOPLAYER specifies that the                              **/
  109. /** position is unoccupied.                                                **/
  110. /****************************************************************************/
  111.  
  112.  
  113. 6. BOOL WINAPI C4_IsWinner (long player)
  114. /****************************************************************************/
  115. /**                                                                        **/
  116. /**  This function returns TRUE if the specified player has won the game,  **/
  117. /**  and FALSE otherwise.                                                  **/
  118. /**                                                                        **/
  119. /****************************************************************************/
  120.  
  121.  
  122. 7. BOOL WINAPI C4_IsTie (void)
  123.  
  124.  
  125. /****************************************************************************/
  126. /**                                                                        **/
  127. /**  This function returns TRUE if the board is completely full and there  **/
  128. /**  is no winner. FALSE otherwise.                                        **/
  129. /**                                                                        **/
  130. /****************************************************************************/
  131.  
  132.  
  133. 8. VOID WINAPI C4_WinCoords (long player, long* x1, long* y1, long* x2, long* y2)
  134.  
  135.  
  136. /****************************************************************************/
  137. /**                                                                        **/
  138. /**  This function returns the coordinates of the winning connections of   **/
  139. /**  the specified player.  It is assumed that the specified player has    **/
  140. /**  indeed won the game.  The coordinates are returned in x1, y1, x2, y2, **/
  141. /**  where (x1, y1) specifies the starting piece of the winning            **/
  142. /**  connection, and (x2, y2) specifies the ending piece of the            **/
  143. /**  winning connection. If more than one winning connection exists, only  **/
  144. /**  one will be returned.                                                 **/
  145. /**                                                                        **/
  146. /****************************************************************************/
  147.  
  148.  
  149. 9. VOID WINAPI C4_EndGame (void)
  150.  
  151.  
  152. /****************************************************************************/
  153. /**                                                                        **/
  154. /**  This function ends the current game.  It is assumed that a game is    **/
  155. /**  indeed in progress.  It is illegal to call any other game function    **/
  156. /**  immediately after this one except for C4_NewGame().                   **/
  157. /**                                                                        **/
  158. /****************************************************************************/
  159.  
  160.  
  161. 10. BOOL WINAPI C4_EnumLevels (long level, char* pc, size_t size)
  162.  
  163.  
  164. /****************************************************************************/
  165. /**                                                                        **/
  166. /**  This function is used to learn about which skill levels the engine    **/
  167. /**  supports. For example, if an engine supports three skill levels, 0-2  **/
  168. /**  then this function would return TRUE if 'level' >=0 and level < 3.    **/
  169. /**  The value of pc might be "Easy", "Intermediate" and "Hard" for levels **/
  170. /**  0, 1 and 2 respectively.                                              **/
  171. /**                                                                        **/
  172. /****************************************************************************/
  173.  
  174.